Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: highlight the use of machine name for orgs help #326

Merged
merged 1 commit into from
Mar 14, 2019

Conversation

lirantal
Copy link
Member

@lirantal lirantal commented Jan 9, 2019

  • Ready for review
  • Follows CONTRIBUTING rules
  • Reviewed by Snyk internal team

What does this PR do?

Current help advises to use specify the org name but it isn't clear about the fact that you need to specify the "machine name" representation of the org name.

If I have an org called "Liran demo", it has a machine name of "liran-demo-123" associated with it and the latter is the one that should be provided to the CLI.

Copy link
Contributor

@robcresswell robcresswell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that machine-name is really clear; perhaps post an example alongside it, or clarify that it's the "machine name not the humanised name"?

@lirantal
Copy link
Member Author

@robcresswell agree about the example, I had the same feeling. Question is how would we refer to that name if not by "machine name" ?

@robcresswell
Copy link
Contributor

I think filling out the text with an example should be enough. More bothered about clarity than pretty help output :)

@lirantal
Copy link
Member Author

@robcresswell how does it read now?

@lili2311 lili2311 merged commit d956d67 into master Mar 14, 2019
@lili2311 lili2311 deleted the fix/help-for-orgs branch March 14, 2019 18:41
@snyksec
Copy link

snyksec commented Mar 14, 2019

🎉 This PR is included in version 1.136.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants